sample Namespace Reference

Functions
def	myfunction (arg1, arg2, kwarg='whatever.')
	Does nothing more than demonstrate syntax. More...

Function Documentation

myfunction()

def sample.myfunction	(		arg1,
			arg2,
			kwarg = 'whatever.'
	)

Does nothing more than demonstrate syntax.

This is an example of how a Pythonic human-readable docstring can get parsed by doxypypy and marked up with Doxygen commands as a regular input filter to Doxygen.

Parameters

arg1	A positional argument.
arg2	Another positional argument.
kwarg	A keyword argument.

Returns

A string holding the result.

Exceptions

ZeroDivisionError
AssertionError
ValueError.	Examples >>> myfunction(2, 3) '5 - 0, whatever.' >>> myfunction(5, 0, 'oops.') Traceback (most recent call last): ... ZeroDivisionError: integer division or modulo by zero >>> myfunction(4, 1, 'got it.') '5 - 4, got it.' >>> myfunction(23.5, 23, 'oh well.') Traceback (most recent call last): ... AssertionError >>> myfunction(5, 50, 'too big.') Traceback (most recent call last): ... ValueError